/*
 * MSG: Meta SimGrid : an extension to SimGrid for distributed scheduling
 * Copyright (C) 2002 "the MSG Team" (see AUTHORS file)
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2, or (at
 * your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
 * USA.
 */

#ifndef MSG_DATATYPE_H
#define MSG_DATATYPE_H

/********************************* Host **************************************/

struct s_m_host {
  char *name;			/* host name if any */
  void *simdata;		/* simulator data */
  void *data;			/* user data */
};
/** \brief Host datatype  
    \ingroup m_datatypes_management

    A <em>location</em> (or <em>host</em>) is any possible place where
    a process may run. Thus it is represented as a <em>physical
    resource with computing capabilities</em>, some <em>mailboxes</em>
    to enable running process to communicate with remote ones, and
    some <em>private data</em> that can be only accessed by local
    process.

    \see m_host_management
*/
typedef struct s_m_host *m_host_t;

/********************************* Link **************************************/
struct s_m_link {
  char *name;			/* link name if any */
  void *simdata;		/* simulator data */
  void *data;			/* user data */
};

/** \brief Link datatype  
    \ingroup m_datatypes_management

    A <em>link</em> is an agglomeration of communicating resources
    representing a set of physical network links.

    \see m_link_management
*/
typedef struct s_m_link *m_link_t;

/********************************* Task **************************************/

struct s_m_task {
  char *name;			/* host name if any */
  void *simdata;		/* simulator data */
  void *data;			/* user data */
};
/** \brief Task datatype  
    \ingroup m_datatypes_management 

    A <em>task</em> may then be defined by a <em>computing
    amount</em>, a <em>message size</em> and some <em>private
    data</em>.
    \see m_task_management
*/
typedef struct s_m_task *m_task_t;

/** \brief Default value for an uninitialized #m_task_t.
    \ingroup m_datatypes_management 
*/
#define MSG_TASK_UNINITIALIZED NULL
/******************************* Process *************************************/

struct s_m_process {
  char *name;			/* host name if any */
  void *simdata;		/* simulator data */
  void *data;			/* user data */
};
/** \brief Agent datatype  
    \ingroup m_datatypes_management 
    An agent may be defined as a <em>code</em>, with some <em>private
    data</em>, executing in a <em>location</em>.
    \see m_process_management
*/
typedef struct s_m_process *m_process_t;
/** \brief Agent code datatype  
    \ingroup m_datatypes_management 
    The code of an agent is a m_process_code_t, i.e. a function with no arguments 
    returning no value.
    \see m_process_management
*/
typedef int(*m_process_code_t)(int argc,char *argv[]) ;

/********************************** Channel **********************************/
/** \brief Channel datatype  
    \ingroup m_datatypes_management 
    A <em>channel</em>  is a number and identifies a mailbox type (just as a 
    port number does).
    \see m_channel_management
*/
typedef int m_channel_t;

/****************************** Error handling *******************************/
/** \brief Error handling
*/typedef enum {
  MSG_OK = 0,  /**< Everything is right. Keep on going this way ! */
  MSG_WARNING, /**< Mmmh! Something must be not perfectly clean. But I
      may be a paranoid freak... ! */
  MSG_TRANSFER_FAILURE, /**< There has been a problem during you task
      transfer. Either the network is down or the remote host has been
      shutdown. */
  MSG_HOST_FAILURE, /**< System shutdown. The host on which you are
      running has just been rebooted. Free your datastructures and
      return now !*/
  MSG_FATAL /**< You've done something wrong. You'd better look at it... */
} MSG_error_t;

typedef enum {
  MSG_SILENT = 0,
  MSG_SOME,
  MSG_VERBOSE
} MSG_outputmode_t;

typedef enum {
  MSG_STORE_AND_FORWARD = 1, /* 0 means uninitialized value */
  MSG_TCP
} MSG_sharing_t;

#endif
